3.04. Markdown
Разработчику
Аналитику
Тестировщику
Архитектору
Инженеру
Техническому писателю
Markdown (MD)
★ Markdown - легковесный язык разметки, созданный для форматирования текста. Он позволяет писать простой и читаемый текст, который легко преобразуется в HTML или другие форматы (например, PDF). Этот язык был разработан Джоном Грубером в 2004 году с целью упростить написание структурированного текста. Исходный текст можно понять даже без преобразования, и нет необходимости учить сложные разметки, вроде HTML.
★ Элементы Markdown
Заголовки создаются с помощью символа #. Чем больше #, тем меньше уровень заголовка:
# Заголовок 1
## Заголовок 2
### Заголовок 3
Итог:
Заголовок 1
Заголовок 2
Заголовок 3
Выделение текста: Жирный текст - две звёздочки или два подчёркивания:
**Жирный текст**
__Жирный текст__
Курсив - одна звёздочка (*) или одно подчёркивание (_):
*Курсив*
_Курсив_
Жирный курсив - три звёздочки (***) или три подчёркивания (___):
***Жирный курсив***
___Жирный курсив___
Списки могут быть нумерованными:
1. Первый пункт
2. Второй пункт
3. Третий пункт
Маркированными:
- Первый пункт
- Второй пункт
- Третий пункт
Вложенными:
- Пункт 1
- Подпункт 1.1
- Подпункт 1.2
Ссылки создаются при помощи квадратных скобок [текст] и круглых скобок (URL):
[GitHub](https://github.com )
Изображения добавляются с помощью восклицательного знака !, квадратных скобок [alt-текст] и круглых скобок (URL):
Цитаты создаются с помощью символа >:
> Это цитата.
Встроенный код оформляется через одинарные апострофы:
Используйте команду `ls` для просмотра файлов.
Блок кода встраивается через три обратных апострофа.
Таким образом, Markdown поддерживает заголовки, списки, блоки текста, кодовые блоки, ссылки и изображения. Где же он применяется?
Главное, с чем сталкивается любой айтишник - README-файлы на GitHub. Файл README.md является стандартом, содержащим описание программы или проекта. Там же можно найти и лучшую документацию по этому формату:
Также MD используется в документации API, руководствах пользователя. Словом, не всё оформляется через Word - есть более изящные и простые решения.